FSM API

The Webhook technology allows to notify partners that subscribed to the notification service in the near-real-time mode when a change is happening on the VINCI Energies business data.

Security implementation

Based upon the enrollment process, the DALI solution has a dedicated credential set to connect to the partner it has to sync with.

Currently supported authentication schemes:

• client_id / client_secret (prefered method)
• Basic authentication
• api key

Format of the Webhook HTTP callout

The Webhook callout is unique for all partners registered to the notification service. Partners should provide a Webhook URL where the notification will be sent to.

The Webhook URI should support:

• POST HTTP method
• Following request headers:

Content-type: application/json
Authorization: basic {Base64 encoded credentials provided by the partner} OR
client_id: {client_id provided by the partner}
client_secret: {client_secret provided by the partner}

• Payload:

{
    "messageCreationTimestamp": "{ISO 8601 Timestamp issued from the data capture (exp level)}",
    "correlationId": "{correlationId conveyed all along the transaction}",
    "messageTag": "{message tag is any [PII,...]}",
    "businessEntity": "{Business Entity name}",
    "businessEntityId": "{Unique ID of the object to be synced}",
    "version": "{schema version}",
    "operationType": {operation type}
    "numberOfRetries": "{Nb of retries}",
    "data": {
             "callInHeaders" : [
                {
                   "key": "{Name of the header param to be included in the input call to href URL}",
                   "value": "{Value that should be used in the header param within input call to href URL}"
                }
              ],
             "href": "{URL to be consumed for fetching the detailed data}"
    }
}